Reverse Penny Drop Verification - Retrieve Bank Details

Description

Objective

The Retrieve Bank Details module provides the bank account details of the user. It also reflects the details of the initial penny drop transaction and its reversal.

Input	Output
The reference and verification IDs from the Retrieve Bank Details module	The details of the user's bank account and the penny drop transaction

Prerequisite

A penny drop transaction done by the user through one of the links generated by the Retrieve Bank Details module.

Input

The following table provides the complete information on the input parameters for the module.

Parameter	Mandatory or Optional	Valid Values	Description
referenceId	Mandatory	Not applicable	The reference ID associated with the payment
verificationId	Mandatory	Not applicable	The unique verification ID for the user

Success Response Sample

The following code is a sample of success response from the module.

{
  "status": "success",
  "statusCode": 200,
  "result": {
      "bank_account": "<Bank_Account_Number_of_the_user>",
      "ifsc": "YESB0000262",
      "upi": "success@upi",
      "name_at_bank": "<User_Name>",
      "verification_id": "157dfgdfg",
      "ref_id": "344",
      "utr": "344",
      "status": "SUCCESS",
      "added_on": "2023-09-06T15:49:14+05:30",
      "processed_on": "2023-09-06T15:49:25+05:30",
      "penny_collected_on": "2023-09-06T15:49:14+05:30",
      "reversal_status": "FAILED"
  },
  "metaData": {
      "requestId": "1694501515982-44335f42-b2df-4fdb-acfe-716728cb6a16",
      "transactionId": "abcde"
  }
}

Success Response Details

The following table provides the details of the parameters in a successful response.

info

*Intent link: A link that directs you to start an activity in another application. It enables seamless navigation and interaction across the applications.

Field	Value	Description
bank_account	String	The full bank account number of the user.
ifsc	String	The IFSC code associated with the bank account.
upi	String	The UPI ID with which the payment is made.
name_at_bank	String	The name of the user associated with the bank account.
verification_id	String	The unique verification ID for the user.
ref_id	String	The reference ID for the payment.
utr	String	The unique Transaction Reference number for the payment.
status	String	The payment status of the user (e.g., "SUCCESS" or "FAILURE").
added_on	String	The timestamp when the payment was added.
processed_on	String	The timestamp when the payment was processed.
penny_collected_on	String	The timestamp when the Penny (₹1) was collected from the user.
reversal_status	String	The reversal status of the collected penny back to the user.

Failure Response Sample

The following is a sample failure response when the verification ID already exists.

{
  "statusCode": 400,
  "status": "failure",
  "error": "verificationId already exists",
  "metaData": {
      "requestId": "1691658819691-d40cd929-e17c-4641-aedb-dac2b775ab71"
  }
}

Error Response Samples

The following are the sample error responses for the module.

Input Length Error

{
  "message": "Input Validation Error: does not meet minimum length of 1",
  "statusCode": 400,
  "status": "failure"
}

Server Error

{
    "statusCode": 500,
    "status": "failure",
    "error": "Internal Server Error"
}

Rate Limit Exceeded

{
  "statusCode": 429,
  "status": "failure",
  "error": "Rate limit exceeded"
}

Failure and Error Response Details

A failure or error response from the module contains a failure status with a relevant status code and error message. The following table lists all error responses.

Status Code	Error Message	Error Description
400	verificationId already exists	The provided verification ID already exists in the system.
400	Input Validation Error: does not meet minimum length of 1	The request did not meet the minimum length requirement of 1.
401	Missing/Invalid credentials	The request is either missing the mandatory credentials or has invalid credentials.
429	Rate limit exceeded	You have exceeded the configured rate limit for transactions per minute.
500	Internal Server Error	Please check the request headers or contact the HyperVerge team for resolution.